Developer Notes for the Jira ICNF

This topic provides developer notes for configuring elements of the Jira connector ICNF file Alemba.Connector.Jira.icnf

The information is provided as-is.

This information is intended for developers who are experienced at customizing ICNF files.

For assistance with configuring the ICNF file, contact your Account Manager to engage an Alemba Professional Services Consultant.

For assistance with troubleshooting problems with the ICNF file, contact your Account Manager to engage an Alemba Professional Services Consultant.

For assistance understanding the information contained in this topic, contact your Account Manager to engage an Alemba Professional Services Consultant.

synchIntervalSec Attribute

Number of seconds between polling Jira for outbound action updates. Default is 300 seconds (5 mins).

Outbound Action Schema State Element

The state element determines whether the outbound action is completed, not completed, open or canceled. By default it is currently using the state matrix defined lower down in the icnf file, based on the statusCategory value being returned from Jira. This could be changed to use the status field instead, if preferred.

vFire Core outbound action states:

0	Open
1	Canceled
2	Completed
3	Not completed

Outbound Action Element

The classID attribute is the unique ID for the outbound action definition.

The display attribute is the name of the outbound action which will be displayed in vFire Core.

The schemaID is the reference to the outbound action schema.

Outbound Action Fields

The fieldSetID attributes relates to the incoming field definition.

The Action Fields HTTP field set should be present in all outbound actions.

Another field set (in this case ALP-Bug Incoming Fields) is also required. This field set needs to be created and is dynamic. Example:

The fieldSetID attribute is the unique identifier for this field set.

The queryID should not change and should remain as “Get Task From Source”.

The schema projectKey and issueType attributes relate to the project and issue type the fields are for. These are required and will be different for each field set.

Outbound Action Arguments

The argument element is used to populate the outgoing fields for Jira. These should be retrieved dynamically, but need to be defined as above for each outbound action.

The argumentSetID references an argumentSet defined lower in the incf file. Example:

The argumentSetID attribute is the unique identifier for this argument set.

The queryID references a query to bring back the available fields to be mapped. Example:

The argument query will define the RESTful request to bring back the list of available fields from Jira. The highlighted values need to be changed based on the project key and issue type.

The yellow highlighting above indicates the lines of code that require editing, as follows:

projectKeys={enter project key}

issuetypeIds={enter issue type}

Outbound Action Create Query

The create element defines which query will be run when the outbound action is first created in vFire Core.

The queryID attribute references the query which will create the issue in Jira.

The highlighted text will need to be changed based on the project key and issue type. The format of the text is {project key}/{issue type}.

Outbound Action Receive Query

The receive element defines which query will be run when vFire Core queries Jira to determine whether any of the outbound actions have been updated since it last polled.

The queryID attribute references the query which will search for the linked issues in Jira.

The highlighted text will need to be changed based on the project key and issue type.

project={enter project key}

type={enter issue type}

Outbound Action Retrieve Query

The retrieve element defines which query will be run when selecting/retrieving information from a Jira issue. It uses the “Get Task” query which will be used across all outbound actions as it uses the unique value of the Jira Issue.

Outbound Action Update Query

The update element defines which query will be run when the vFire Core has call/request has been updated. It uses the “Update Query” query which will be used across all outbound actions as it uses the unique value of the Jira Issue.

Outbound Action Notify Query

The notify element defines which query will be run when a note has been added to the call and will send as a comment to Jira. It uses the “Notify Query” query which will be used across all outbound actions as it uses the unique value of the Jira Issue.

Outbound Action Cancel Query

The cancel element defines which query will be run when the call/request has been closed in vFire Core. It uses the “Update Query” query which will be used across all outbound actions as it uses the unique value of the Jira Issue.